home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / efun / save_object < prev    next >
Text File  |  2001-04-06  |  960b  |  26 lines
  1. SYNOPSIS
  2.         int    save_object (string name)
  3.         string save_object ()             (PRELIMINARY)
  4.  
  5. DESCRIPTION
  6.         Encode the publicly visible variables of the current object
  7.         into a string.
  8.  
  9.         In the first form, the string is written to the file <name>.
  10.         A suffix ".c" will be stripped from the name, the suffix ".o"
  11.         may be added by the master object during the check in
  12.         valid_read(). Result is 0 if the save file could be created,
  13.         and non-zero on a non-fatal error (file could not be written,
  14.         or current object is destructed).
  15.  
  16.         In the second form the string is returned directly. If the
  17.         object is destructed, the result is 0.
  18.  
  19. HISTORY
  20.         Since LDMud 3.2.8, save_object() returns a success value.
  21.         The direct encoding into a string was added in LDMud 3.2.8, but
  22.         may be moved into a different efun in future.
  23.  
  24. SEE ALSO
  25.         restore_object(E), save_value(E)
  26.